/*
 * Copyright 2006 Matt Jensen
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
 * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations under the License.
 */
package org.spectaql.internal.query;

import org.spectaql.internal.SpectaqlContextInternal;
import org.spectaql.metadata.PropertyMetadata;

/**
 * <p>
 * <code>QueryContextInternal</code> defines the internal interface to a query context. It defines methods which are
 * used internally in the process of building dynamic queries.
 * </p>
 * <p>
 * <strong>The methods defined by this interface should not be accessed by the client application.</strong>
 * </p>
 */
public interface QueryContextInternal
{
    /**
     * <p>
     * Record information on a matcher entity property accessor invocation in the property reference queue.
     * </p>
     *
     * @param propertyMetadata the property metadata.
     */
    void addPropertyReference(PropertyMetadata propertyMetadata);

    /**
     * <p>
     * Record information on a sub-property accessor invocation in the item at the tail of the property reference queue.
     * </p>
     *
     * @param propertyMetadata the property metadata.
     */
    void addSubPropertyReference(PropertyMetadata propertyMetadata);

    /**
     * <p>
     * Get the owning {@link SpectaqlContextInternal} instance.
     * </p>
     *
     * @return {@link SpectaqlContextInternal} intance.
     */
    SpectaqlContextInternal getSpectaqlContext();
}
